docs: no em dashes in the docs or the report strings - #21
Merged
Merged
Conversation
…n new ones Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
Owner
Author
|
Correction to the description above: I said the example report's latency line "differs on every run". It does not. The mock simulates latency from its seed, so a rerun of the recorded command reproduces every line of the report, latency included, and the hand edits in this PR are byte-identical to what the code now prints. The site build now checks every line (only the date and path separators are normalized); see the follow-up PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replaces the 34 em dashes left in tracked markdown and
src/, and adds a CI job so they do not come back.Replaced (34):
src/plumbline/report/markdown.py: 18. All of them were the report's bullet separator,- **Label** — text, which becomes- **Label**: text. This changes report text, not any number. No test pinned the old separator.docs/example-report.md: 5. These are the same bullets. I changed them to match what the code now emits rather than regenerating the file, because the latency line differs on every run. The build still checks the ECE and accuracy lines against a fresh run, and it passes.docs/PLAN.md: 7.datasets/public/README.md: 3 (our file, not the vendored one).CHANGELOG.md: 1. Each one was rewritten with a colon, parentheses, or a comma, whichever the sentence needed.Untouched:
datasets/public/jevbench-hard.jsonl(60 em dashes in the vendored MIT rows) andLICENSE-jevbench.CI: a new
prosejob inci.ymlrunsgit grep -P '\x{2014}' -- '*.md' 'src/' ':!datasets/public/'and fails if it finds anything. I tested it locally both ways: it passes on this tree and catches a dash I injected.Local: ruff, format, mypy, the full pytest suite, and
build_site.pyall pass.🤖 Generated with Claude Code